Add User Guide to docs #8
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pressler-vsc
requested review from
mtrachy,
bombaci-vsc,
dhaverporth,
mstewart-vsc and
johnstob
johnstob
approved these changes
Jan 7, 2025
bombaci-vsc
approved these changes
Jan 7, 2025
mtrachy
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a "User Guide" to the SARkit docs.
The proposed documentation from this branch is currently hidden but available at:
https://sarkit.readthedocs.io/en/user-guide/user_guide.html
Notes
doctestrun tonoxfile.pyto get some level of checking on the code snippets in the docsproject.urlsto the pyproject.toml